<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  <title>tango.text.Unicode</title>
  <link href="./css/style.css" rel="stylesheet" type="text/css"/>
  <!-- <link href="./img/icon.png" rel="icon" type="image/png"/> -->
  <script type="text/javascript" src="./js/jquery.js"></script>
  <script type="text/javascript" src="./js/modules.js"></script>
  <script type="text/javascript" src="./js/quicksearch.js"></script>
  <script type="text/javascript" src="./js/navigation.js"></script>
  <!--<script type="text/javascript" src="./js/jquery.treeview.js"></script>-->
  <script type="text/javascript">
    var g_moduleFQN = "tango.text.Unicode";
  </script>
  
</head>
<body>
<div id="content">
  <h1><a href="./htmlsrc/tango.text.Unicode.html" class="symbol">tango.text.Unicode</a></h1>
  
<p class="sec_header">License:</p>BSD style: see <a href="http://www.dsource.org/projects/tango/wiki/LibraryLicense">license.txt</a>
<p class="sec_header">Version:</p>Initial release: Sept 2007
<p class="sec_header">Authors:</p>Peter
<p class="bl"/>
        Provides case mapping Functions for Unicode Strings. As of now it is
        only 99 % complete, because it does not take into account Conditional
        case mappings. This means the Greek Letter Sigma will not be correctly
        case mapped at the end of a Word, and the Locales Lithuanian, Turkish
        and Azeri are not taken into account during Case Mappings. This means
        all in all around 12 Characters will not be mapped correctly under
        some circumstances.
<p class="bl"/>
        ICU4j also does not handle these cases at the moment.
<p class="bl"/>
        Unittests are written against output from ICU4j
<p class="bl"/>
        This Module tries to minimize Memory allocation and usage. You can
        always pass the output buffer that should be used to the case mapping
        function, which will be resized if necessary.
<dl>
<dt class="decl">char[] <a class="symbol _function" name="blockToUpper" href="./htmlsrc/tango.text.Unicode.html#L44" kind="function" beg="44" end="81">blockToUpper</a><span class="params">(char[] <em>input</em>, char[] <em>output</em> = null, dchar[] <em>working</em> = null)</span>; <span class="attrs">[<span class="stc">deprecated</span>]</span> <a title="Permalink to this symbol" href="#blockToUpper" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.text.Unicode.html#L44">#</a></dt>
<dd class="ddef">
<div class="summary">Converts an Utf8 String to Upper case</div>
<p class="sec_header">Params:</p>
<table class="params">
<tr><td><em>input</em></td><td>String to be case mapped</td></tr>
<tr><td><em>output</em></td><td>this output buffer will be used unless too small</td></tr></table>
<p class="sec_header">Returns:</p>the case mapped string</dd>
<dt class="decl">char[] <a class="symbol _function" name="toUpper" href="./htmlsrc/tango.text.Unicode.html#L93" kind="function" beg="93" end="138">toUpper</a><span class="params">(char[] <em>input</em>, char[] <em>output</em> = null)</span>; <a title="Permalink to this symbol" href="#toUpper" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.text.Unicode.html#L93">#</a></dt>
<dd class="ddef">
<div class="summary">Converts an Utf8 String to Upper case</div>
<p class="sec_header">Params:</p>
<table class="params">
<tr><td><em>input</em></td><td>String to be case mapped</td></tr>
<tr><td><em>output</em></td><td>this output buffer will be used unless too small</td></tr></table>
<p class="sec_header">Returns:</p>the case mapped string</dd>
<dt class="decl">wchar[] <a class="symbol _function" name="toUpper:2" href="./htmlsrc/tango.text.Unicode.html#L149" kind="function" beg="149" end="193">toUpper</a><span class="params">(wchar[] <em>input</em>, wchar[] <em>output</em> = null)</span>; <a title="Permalink to this symbol" href="#toUpper:2" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.text.Unicode.html#L149">#</a></dt>
<dd class="ddef">
<div class="summary">Converts an Utf16 String to Upper case</div>
<p class="sec_header">Params:</p>
<table class="params">
<tr><td><em>input</em></td><td>String to be case mapped</td></tr>
<tr><td><em>output</em></td><td>this output buffer will be used unless too small</td></tr></table>
<p class="sec_header">Returns:</p>the case mapped string</dd>
<dt class="decl">dchar[] <a class="symbol _function" name="toUpper:3" href="./htmlsrc/tango.text.Unicode.html#L203" kind="function" beg="203" end="234">toUpper</a><span class="params">(dchar[] <em>input</em>, dchar[] <em>output</em> = null)</span>; <a title="Permalink to this symbol" href="#toUpper:3" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.text.Unicode.html#L203">#</a></dt>
<dd class="ddef">
<div class="summary">Converts an Utf32 String to Upper case</div>
<p class="sec_header">Params:</p>
<table class="params">
<tr><td><em>input</em></td><td>String to be case mapped</td></tr>
<tr><td><em>output</em></td><td>this output buffer will be used unless too small</td></tr></table>
<p class="sec_header">Returns:</p>the case mapped string</dd>
<dt class="decl">char[] <a class="symbol _function" name="toLower" href="./htmlsrc/tango.text.Unicode.html#L245" kind="function" beg="245" end="290">toLower</a><span class="params">(char[] <em>input</em>, char[] <em>output</em> = null)</span>; <a title="Permalink to this symbol" href="#toLower" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.text.Unicode.html#L245">#</a></dt>
<dd class="ddef">
<div class="summary">Converts an Utf8 String to Lower case</div>
<p class="sec_header">Params:</p>
<table class="params">
<tr><td><em>input</em></td><td>String to be case mapped</td></tr>
<tr><td><em>output</em></td><td>this output buffer will be used unless too small</td></tr></table>
<p class="sec_header">Returns:</p>the case mapped string</dd>
<dt class="decl">wchar[] <a class="symbol _function" name="toLower:2" href="./htmlsrc/tango.text.Unicode.html#L301" kind="function" beg="301" end="345">toLower</a><span class="params">(wchar[] <em>input</em>, wchar[] <em>output</em> = null)</span>; <a title="Permalink to this symbol" href="#toLower:2" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.text.Unicode.html#L301">#</a></dt>
<dd class="ddef">
<div class="summary">Converts an Utf16 String to Lower case</div>
<p class="sec_header">Params:</p>
<table class="params">
<tr><td><em>input</em></td><td>String to be case mapped</td></tr>
<tr><td><em>output</em></td><td>this output buffer will be used unless too small</td></tr></table>
<p class="sec_header">Returns:</p>the case mapped string</dd>
<dt class="decl">dchar[] <a class="symbol _function" name="toLower:3" href="./htmlsrc/tango.text.Unicode.html#L356" kind="function" beg="356" end="387">toLower</a><span class="params">(dchar[] <em>input</em>, dchar[] <em>output</em> = null)</span>; <a title="Permalink to this symbol" href="#toLower:3" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.text.Unicode.html#L356">#</a></dt>
<dd class="ddef">
<div class="summary">Converts an Utf32 String to Lower case</div>
<p class="sec_header">Params:</p>
<table class="params">
<tr><td><em>input</em></td><td>String to be case mapped</td></tr>
<tr><td><em>output</em></td><td>this output buffer will be used unless too small</td></tr></table>
<p class="sec_header">Returns:</p>the case mapped string</dd>
<dt class="decl">char[] <a class="symbol _function" name="toFold" href="./htmlsrc/tango.text.Unicode.html#L398" kind="function" beg="398" end="436">toFold</a><span class="params">(char[] <em>input</em>, char[] <em>output</em> = null)</span>; <a title="Permalink to this symbol" href="#toFold" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.text.Unicode.html#L398">#</a></dt>
<dd class="ddef">
<div class="summary">Converts an Utf8 String to Folding case
 Folding case is used for case insensitive comparsions.</div>
<p class="sec_header">Params:</p>
<table class="params">
<tr><td><em>input</em></td><td>String to be case mapped</td></tr>
<tr><td><em>output</em></td><td>this output buffer will be used unless too small</td></tr></table>
<p class="sec_header">Returns:</p>the case mapped string</dd>
<dt class="decl">wchar[] <a class="symbol _function" name="toFold:2" href="./htmlsrc/tango.text.Unicode.html#L447" kind="function" beg="447" end="484">toFold</a><span class="params">(wchar[] <em>input</em>, wchar[] <em>output</em> = null)</span>; <a title="Permalink to this symbol" href="#toFold:2" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.text.Unicode.html#L447">#</a></dt>
<dd class="ddef">
<div class="summary">Converts an Utf16 String to Folding case
 Folding case is used for case insensitive comparsions.</div>
<p class="sec_header">Params:</p>
<table class="params">
<tr><td><em>input</em></td><td>String to be case mapped</td></tr>
<tr><td><em>output</em></td><td>this output buffer will be used unless too small</td></tr></table>
<p class="sec_header">Returns:</p>the case mapped string</dd>
<dt class="decl">dchar[] <a class="symbol _function" name="toFold:3" href="./htmlsrc/tango.text.Unicode.html#L495" kind="function" beg="495" end="519">toFold</a><span class="params">(dchar[] <em>input</em>, dchar[] <em>output</em> = null)</span>; <a title="Permalink to this symbol" href="#toFold:3" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.text.Unicode.html#L495">#</a></dt>
<dd class="ddef">
<div class="summary">Converts an Utf32 String to Folding case
 Folding case is used for case insensitive comparsions.</div>
<p class="sec_header">Params:</p>
<table class="params">
<tr><td><em>input</em></td><td>String to be case mapped</td></tr>
<tr><td><em>output</em></td><td>this output buffer will be used unless too small</td></tr></table>
<p class="sec_header">Returns:</p>the case mapped string</dd>
<dt class="decl">bool <a class="symbol _function" name="isDigit" href="./htmlsrc/tango.text.Unicode.html#L529" kind="function" beg="529" end="532">isDigit</a><span class="params">(dchar <em>ch</em>)</span>; <a title="Permalink to this symbol" href="#isDigit" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.text.Unicode.html#L529">#</a></dt>
<dd class="ddef">
<div class="summary">Determines if a character is a digit. It returns true for decimal
 digits only.</div>
<p class="sec_header">Params:</p>
<table class="params">
<tr><td><em>ch</em></td><td>the character to be inspected</td></tr></table></dd>
<dt class="decl">bool <a class="symbol _function" name="isLetter" href="./htmlsrc/tango.text.Unicode.html#L541" kind="function" beg="541" end="549">isLetter</a><span class="params">(int <em>ch</em>)</span>; <a title="Permalink to this symbol" href="#isLetter" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.text.Unicode.html#L541">#</a></dt>
<dd class="ddef">
<div class="summary">Determines if a character is a letter.</div>
<p class="sec_header">Params:</p>
<table class="params">
<tr><td><em>ch</em></td><td>the character to be inspected</td></tr></table></dd>
<dt class="decl">bool <a class="symbol _function" name="isLetterOrDigit" href="./htmlsrc/tango.text.Unicode.html#L558" kind="function" beg="558" end="567">isLetterOrDigit</a><span class="params">(int <em>ch</em>)</span>; <a title="Permalink to this symbol" href="#isLetterOrDigit" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.text.Unicode.html#L558">#</a></dt>
<dd class="ddef">
<div class="summary">Determines if a character is a letter or a
 decimal digit.</div>
<p class="sec_header">Params:</p>
<table class="params">
<tr><td><em>ch</em></td><td>the character to be inspected</td></tr></table></dd>
<dt class="decl">bool <a class="symbol _function" name="isLower" href="./htmlsrc/tango.text.Unicode.html#L574" kind="function" beg="574" end="577">isLower</a><span class="params">(dchar <em>ch</em>)</span>; <a title="Permalink to this symbol" href="#isLower" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.text.Unicode.html#L574">#</a></dt>
<dd class="ddef">
<div class="summary">Determines if a character is a lower case letter.</div>
<p class="sec_header">Params:</p>
<table class="params">
<tr><td><em>ch</em></td><td>the character to be inspected</td></tr></table></dd>
<dt class="decl">bool <a class="symbol _function" name="isTitle" href="./htmlsrc/tango.text.Unicode.html#L587" kind="function" beg="587" end="590">isTitle</a><span class="params">(dchar <em>ch</em>)</span>; <a title="Permalink to this symbol" href="#isTitle" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.text.Unicode.html#L587">#</a></dt>
<dd class="ddef">
<div class="summary">Determines if a character is a title case letter.
 In case of combined letters, only the first is upper and the second is lower.
 Some of these special characters can be found in the croatian and greek language.</div>
<p class="sec_header">See Also:</p>http://en.wikipedia.org/wiki/Capitalization
<p class="sec_header">Params:</p>
<table class="params">
<tr><td><em>ch</em></td><td>the character to be inspected</td></tr></table></dd>
<dt class="decl">bool <a class="symbol _function" name="isUpper" href="./htmlsrc/tango.text.Unicode.html#L597" kind="function" beg="597" end="600">isUpper</a><span class="params">(dchar <em>ch</em>)</span>; <a title="Permalink to this symbol" href="#isUpper" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.text.Unicode.html#L597">#</a></dt>
<dd class="ddef">
<div class="summary">Determines if a character is a upper case letter.</div>
<p class="sec_header">Params:</p>
<table class="params">
<tr><td><em>ch</em></td><td>the character to be inspected</td></tr></table></dd>
<dt class="decl">bool <a class="symbol _function" name="isWhitespace" href="./htmlsrc/tango.text.Unicode.html#L616" kind="function" beg="616" end="627">isWhitespace</a><span class="params">(dchar <em>ch</em>)</span>; <a title="Permalink to this symbol" href="#isWhitespace" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.text.Unicode.html#L616">#</a></dt>
<dd class="ddef">
<div class="summary">Determines if a character is a Whitespace character.
 Whitespace characters are characters in the
 General Catetories Zs, Zl, Zp without the No Break
 spaces plus the control characters out of the ASCII
 range, that are used as spaces:
 TAB VT LF FF CR FS GS RS US NL</div>
<p class="sec_header">WARNING:</p>look at isSpace, maybe that function does
          more what you expect.
<p class="sec_header">Params:</p>
<table class="params">
<tr><td><em>ch</em></td><td>the character to be inspected</td></tr></table></dd>
<dt class="decl">bool <a class="symbol _function" name="isSpace" href="./htmlsrc/tango.text.Unicode.html#L639" kind="function" beg="639" end="645">isSpace</a><span class="params">(dchar <em>ch</em>)</span>; <a title="Permalink to this symbol" href="#isSpace" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.text.Unicode.html#L639">#</a></dt>
<dd class="ddef">
<div class="summary">Detemines if a character is a Space character as
 specified in the Unicode Standard.</div>
<p class="sec_header">WARNING:</p>look at isWhitespace, maybe that function does
          more what you expect.
<p class="sec_header">Params:</p>
<table class="params">
<tr><td><em>ch</em></td><td>the character to be inspected</td></tr></table></dd>
<dt class="decl">bool <a class="symbol _function" name="isPrintable" href="./htmlsrc/tango.text.Unicode.html#L655" kind="function" beg="655" end="663">isPrintable</a><span class="params">(dchar <em>ch</em>)</span>; <a title="Permalink to this symbol" href="#isPrintable" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.text.Unicode.html#L655">#</a></dt>
<dd class="ddef">
<div class="summary">Detemines if a character is a printable character as
 specified in the Unicode Standard.</div>
<p class="sec_header">Params:</p>
<table class="params">
<tr><td><em>ch</em></td><td>the character to be inspected</td></tr></table></dd></dl>
</div>
<div id="footer">
  <p>Copyright (c) 2007 Peter Triller. All rights reserved</p>
  <p>Page generated by <a href="http://code.google.com/p/dil">dil</a> on Fri Dec 26 04:04:15 2008. Rendered by <a href="http://code.google.com/p/dil/wiki/Kandil">kandil</a>.</p>
</div>
</body>
</html>